home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
CD ROM Paradise Collection 4
/
CD ROM Paradise Collection 4 1995 Nov.iso
/
filutil
/
vndvue13.zip
/
VENDVIEW.DOC
< prev
next >
Wrap
Text File
|
1995-06-30
|
34KB
|
945 lines
+----------------------------------------+
| |
| |
| User's Guide |
| |
| VendView(TM) Viewer |
| for displaying VENDINFO.DIZ files |
| Version 1.30-012 |
| |
| |
| Last updated: June 1995 |
| |
| |
| Copyright 1994-5 Rams' Island Software |
| All rights reserved |
| |
+----------------------------------------+
Rams' Island Software Member: ASP ESC STAR
7644 E. Lakecliff Way
Parker, CO 80134-5904 CIS: 76244,324 BBS: 303-841-6269
USA Fido: 1:104/333 RIME: 1235
Inet: ramsisle@abwam.com
303-841-2848 FTP: ftp://ftp.abwam.com/pub/ramsisle
303-841-6269 (Fax) WWW: http://delta.com/ramsisle/ramsisle.htm
VendView User's Guide VendView
+-----------------+
| Acknowledgments |
+-----------------+
Many people have helped to mold the VENDINFO vision, and to provide
support and encouragement throughout its development process. Thanks are
given to all those who have reviewed the Concept Paper or the VENDINFO
standard, or who have otherwise made suggestions regarding the project.
The author is especially grateful to Fred Hill and Richard Holler, for
long-term support and help with VENDINFO.
While many have reviewed parts of the VENDINFO documentation, special
thanks go to Jim Green, for helping us avoid a wrong direction; to Bob
Ostrander for a simple but particularly powerful idea; and to Daan van
Rooijen, for really studying the standard and providing many, many
useful suggestions.
Many people have also helped in beta testing the VENDINFO tools, and
we're grateful to them all. Special thanks are given to Steve Estvanik,
Jerry Stern, and Rosemary West, for really giving things a workout, and
tirelessly reporting the results.
The VENDINFO team is grateful to the following shareware trade associa-
tions for their endorsements of VENDINFO:
Association of Shareware Professionals (ASP)
Association of Shareware Authors and Distributors (ASAD)
Shareware Trade Association and Resources (STAR)
Educational Software Copperative (ESC)
Finally, we particularly appreciate the 30-or-so software development
teams (mostly BBS-related) whose early commitment to support the
VENDINFO standard in their software products has helped provide momentum
and visibility to this effort.
VENDINFO, VendEdit, VendPrcs, VendView, and VendLib are trademarks of
Rams' Island Software.
VendView Viewer v1.30 -ii- Jun 1995
VendView User's Guide Table of Contents
+-------------------+
| Table of Contents |
+-------------------+
The VENDINFO System ................................................ 1
Components of the System ........................................ 1
Structure of a VENDINFO File .................................... 2
A Little Background ............................................. 3
Industry Support and Endorsements ............................... 4
Other VENDINFO Documents and Packages ........................... 5
Installation ....................................................... 7
Quick Start ..................................................... 7
Detailed Contents of the VendView Package ....................... 8
Warranty and License ............................................ 9
Technical Support for VendView .................................. 9
VendView: A User's Viewer for VENDINFO Files ....................... 11
Use of VendView Simply to View VENDINFO Files ................... 11
Use of VendView to Test Package Integrity ....................... 12
VendView Viewer v1.30 -iii- Jun 1995
VendView User's Guide Introduction to VENDINFO
+---------------------+
| The VENDINFO System |
+---------------------+
VENDINFO is a system for conveying software product information and
distribution permissions from the author to distributors and users. A
standard (public) file format allows a VENDINFO.DIZ file to carry
extensive information in a compressed, efficient form. The associated
toolset:
o aids the author in constructing the record
o allows the distributor to extract portions of the record, or to
make distribution decisions based on its content, in a highly
automated way
o allows the user to view user-relevant product information quite
easily.
VENDINFO provides unprecedented capabilities for
o Communication of product information and distribution policies
from authors to users and distributors.
o Enforceable distribution policies.
o Automation of many aspects of package handling by shareware
distributors of all types.
Components of the System
------------------------
The VENDINFO "record" is the key. This is an efficiently compressed
file (VENDINFO.DIZ) containing a great deal of information about the
product, the author, and the product's distribution policies.
The VendEdit editor allows the author to construct a complete
VENDINFO record in just a few minutes, assuming that the necessary
descriptive texts have already been prepared.
The VendPrcs (pronounced "vend process") processor is a batch program
allowing automated decisions based on VENDINFO content, and automated
extraction of VENDINFO information.
VendView is a simple menu-driven viewer that allows the end-user to
VendView Viewer v1.30 -1- Jun 1995
VendView User's Guide Introduction to VENDINFO
see relevant portions of the VENDINFO data. Even without VendView, an
ordinary text viewer will display a good deal of useful information.
The Product Registry is a collection of VENDINFO records available
for searches and queries by subscription, BBS login, or mail-order
query.
The VendLib Library allows software developers to build VENDINFO
access directly into such products as BBS programs and upload proces-
sors. It includes C source, a C/C++ compatible library, and a DLL
version.
The file-format standard describing the VENDINFO file is public, and
draft versions have been published since July 1993.
Additional services for authors, users, and distributors are under
consideration.
Structure of a VENDINFO File
----------------------------
The VENDINFO.DIZ file contains two sections. A human-readable front
section contains information about how to use the VENDINFO file, and
presents most of the basic information about the product in readable
form. Optionally, it also includes "read-me" text, installation
instructions, and the product's warranty and trial-use license.
The second section is a binary data record, compressed with a PKZIP
1.10 algorithm, and appended to the file after the first section.
This record has more than 750 fields of information about such things
as
o Product name, date, and version
o Preferred package filename, other parts of product, replaced
versions
o Product descriptions of varying length, categories, keywords
o Required platform (CPU, operating system, memory, disk, fea-
tures)
o Contact information for author, for registering, for tech
support
o Registration prices and benefits, acceptable forms of payment
o Detailed distribution policy, in general and by distribution
VendView Viewer v1.30 -2- Jun 1995
VendView User's Guide Introduction to VENDINFO
channel
o Information about regional distributors and registration serv-
ices.
There is also a specialized version of the VENDINFO file, called
VENDINFO.DOZ (for Description Out of Zip), which can contain addi-
tional information for use by CD-ROM front ends, as an electronic
media kit, as an electronic demonstration kit, and for other uses.
This file can even contain screenshots, icons, sound samples, a logo,
advertising screen, press release, reviewer guidelines, company
background, author biography, product features sheet, question-and-
answer sheet, and other embedded, compressed files. CD-ROM front ends
will soon be using this information, as will the free VendView
viewer.
A Little Background
-------------------
The author of the VENDINFO standard and tools, Rudy Ramsey, has been
agitating since early 1992 for the development of an improved
mechanism for conveying product information and permissions from
authors to distributors. Initially, the intent was to make this a
purely volunteer-based effort, probably conducted within the auspices
of the Association of Shareware Professionals. However, others were
slow to respond to the idea (with the exception of Richard Holler and
Fred Hill), and it gradually became clear that it would have to be
done as an "extracurricular" effort, if at all.
In the Spring of 1993, Rudy began the VENDINFO effort in earnest, by
preparing the CONCEPT.DOC concept paper and distributing it to a few
key shareware industry figures for comment. (At this time, he still
imagined VENDINFO as an all-volunteer effort.) The reviewers were
uniformly excited about the idea, and greatly encouraging. Most felt
that it was an idea whose time had come, and that the technical
approach described in the concept paper was very appropriate.
Their second response, however, was that the effort contained the
seeds of its own failure. It might provide all the necessary incen-
tives for participation by authors, distributors, and users. But if
it didn't also provide an incentive for continued development and
support by its own development team, it would fail. It was simply too
big an activity for successful execution by volunteers.
As a result of that input, a decision was made to regard VENDINFO as
partly a business opportunity. Although this makes a few people
suspicious, most agree it's in the best interest of the VENDINFO
effort itself, and of the industry. In fact, VENDINFO has developed
VendView Viewer v1.30 -3- Jun 1995
VendView User's Guide Introduction to VENDINFO
rapidly, partly because it has been a full-time focus of its author
for many months. That wouldn't have been possible in an all-volunteer
effort.
The VENDINFO file-format standard is public. A substantial period was
provided for public comment on the concept paper, and then on the
standard, and public input is always welcome. Some of the tools that
make use of the standard are free (a viewer for end users, and the
processor when used by single-line, noncommercial BBSes). Most are
low-cost shareware. There will also be much-enhanced, non-shareware
programs later, for special purposes, but none of them are necessary
to achieve the benefits of the VENDINFO system.
Industry Support and Endorsements
---------------------------------
Support for the VENDINFO concept has been extraordinarily high
throughout the industry. Authors, disk vendors, CD-ROM publishers,
Sysops, and BBS software manufacturers have all expressed their
support, and many have pledged to build VENDINFO capability into
their own software products.
The following shareware trade groups have formally endorsed the
VENDINFO file-format standard as a means of conveying product and
product-distribution information from authors to users and dis-
tributors.
Association of Shareware Professionals (ASP)
Shareware Trade Association and Resources (STAR)
Association of Shareware Authors and Developers (ASAD)
Educational Software CoOperative (ESC)
The ASP has licensed the VENDINFO toolset for use by all 1400 of its
members. This will greatly accelerate the use -- and the usefulness
-- of VENDINFO. As of May 1995, 63% of new products distributed by
ASP authors on the official ASP CD-ROM included VENDINFO files, and
the percentage is steadily growing.
The following software manufacturers have "committed in principle" to
support VENDINFO in their own software offerings. In the context of
these products, "support" for VENDINFO means extracting relevant
descriptive information automatically from VENDINFO files. It does
not necessarily mean making decisions based on the product's dis-
tribution policy. VendPrcs will provide that capability.
BBSes
PCBoard, Clark Development Co.
VendView Viewer v1.30 -4- Jun 1995
VendView User's Guide Introduction to VENDINFO
Wildcat!, Mustang Software, Inc.
Major BBS, Galacticomm
RBBS, RBBS Development Team
Searchlight BBS, Searchlight Software
TBBS, eSoft
Executive Host BBS, Steve Wood
MainLine BBS, Scott Green, City Limits Software
OmegaComm BBS, Larry Loiselle
PowerBBS for Windows, Russell Frey
ProBoard BBS, Philippe Leybaert
Sapphire BBS, Pinnacle Software
Tinyhost, Bruce Krobusek
UltraBBS, UltraBBS Software
Windowed Modem Environment, Jason Fesler
File Upload Processors
CatScan, Mike Ortiz
CheckZip, Bill Hull
DIZIT, Robert Neal/CorpSoft
HoboScan, Floyd Hobson
**THD Proscan, David Muir
**TranScan, Craig Dunstan
File Distribution Processors
WCFF, Online Computer Resources
Other Products
**BBSee Disk Cataloger, Martin Vallevand
**Catalog-on-a-Disk, EmmaSoft Software Company, Inc.
Colorado Utilities Disk Manager, Micro Systems Solutions
**SmartCat Disk Cataloger, Oakley Data Services
* Test versions are known to exist which support VENDINFO
** Released products support VENDINFO
Other VENDINFO Documents and Packages
-------------------------------------
The VENDINFO idea is documented in detail in a concept paper and in
the VENDINFO file-format standard. These two documents are available
in the VENDINFO information package, usually named VNDINFxx.ZIP
(where xx represents the version number).
The basic VENDINFO Toolkit (for authors and distributors) is avail-
able in the VendTools package, usually named VNDNFOxx.ZIP. The
VendView Viewer v1.30 -5- Jun 1995
VendView User's Guide Introduction to VENDINFO
VendView viewer package, for end-users, is usually named
VNDVUExx.ZIP. The VendUtil package contains a collection of utilities
and other useful information, and is usually named VNDUTLxx.ZIP.
All of these can be obtained from the Rams' Island BBS on first login
or by FidoNet or RIME file request. (FidoNet magic names for current
versions consist of just the alphabetic portion of the package
prefix, as VNDINF, VNDNFO, VNDVUE, and VNDUTL.) They are available
for Internet FTP at ftp://ftp.abwam.com/pub/ramsisle, and can be
accessed on the World-Wide Web at
http://delta.com/ramsisle/ramsisle.htm. They are available in the
CompuServe SHAREWARE, UKSHARE, and EDFORUM forums; the ASP Hub Net-
work BBSes; many local BBSes around the world, including those as-
sociated with the Software Distribution Network; from some disk
vendors; and on the ASP, JSC, and PsL CD-ROMs.
If necessary, the concept paper and evaluation versions of the basic
toolset can be obtained on diskette from Rams' Island Software for
US$ 6.00 in North America, $8.00 elsewhere. Payment is accepted by
Visa/MasterCard, check in U.S. dollars drawn on a U.S. bank, cash in
any hard currency (registered mail suggested), and various other
forms. cal BBSes around the world, including those associated with
the Software Distribution Network; from some disk vendors; and on the
ASP, JSC, and PsL CD-ROMs.
VendView Viewer v1.30 -6- Jun 1995
VendView User's Guide Installation
+--------------+
| Installation |
+--------------+
To install the VendView viewer, simply unzip or copy all files into a
single directory on your hard drive.
For convenience, you may wish to place the directory on your DOS
PATH, probably via a PATH statement in your AUTOEXEC.BAT file. (Con-
sult your DOS manual if you're unfamiliar with this operation. If
you're using MS-DOS v5.0 or later, you can use the command "help
path" to learn more.)
Many users keep their DOS PATH and directory structure simple, by
placing small utility programs in a single directory rather than
allocating a separate directory for each utility. If you wish to do
this, you can place these files:
VENDVIEW.EXE (the program itself)
VENDVIEW.HLP (the program's help file)
CATEGORY.INF (a list of product categories used by VendView)
into a directory that is already on your DOS PATH. It is inadvisable
to use the \DOS directory for this purpose, but you may find it
convenient to keep such programs in a directory that you create, such
as C:\TOOLS. These three files must be installed in the same direc-
tory, for proper operation of VendView.
The remaining files can be retained or eliminated, as you prefer.
(You may wish to leave all files in the same directory until you've
become familiar with VendView.)
Quick Start
-----------
To invoke VendView on a VENDINFO file, make sure the file is in the
current working directory, and execute the command
vendview
If you have not placed VENDVIEW.EXE in a directory that's on your DOS
path, You'll need to use the full pathname of that file, such as:
c:\vendview\vendview.exe
If you're executing VendView from a read-only medium, such as a CD-
ROM drive, you'll have to use the -d (directory) command-line flag,
VendView Viewer v1.30 -7- Jun 1995
VendView User's Guide Installation
to assign a writeable directory in which VendView can create its
VENDVIEW.CFG configuration file. You might also need to do this if
you're using a version of MS-DOS earlier than 3.0. An example might
be:
d:\files\vendview\vendview.exe -dc:\myconfig
In most cases, software packages will have only one VENDINFO file, it
will have the standard filename VENDINFO.DIZ, and VendView will load
it automatically. If the current directory contains multiple VENDINFO
files, you can either load the preferred file after starting
VendView, or you can specify it by adding the filename to the command
line, as
vendview INCXT11.DIZ
For a really quick start, just invoke VendView in the directory in
which you've installed it. You'll have access to the help system,
which tells you everything you need to know to make use of VendView,
and you'll be able to practice by viewing the VENDINFO.DIZ file that
comes with VendView itself.
The context-sensitive help system should provide you all the addi-
tional information you require. Just press F1 or Alt-H for help.
Pressing F1 twice, from anywhere, will display the help system index.
It is suggested that you use the help information extensively at
first, and specifically that you read the first three items in the
index. These provide a quick introduction to the VENDINFO system in
general, and to the use of VendView in particular.
Detailed Contents of the VendView Package
-----------------------------------------
The VendView package includes the following files:
VENDVIEW.DOC This document.
VENDVIEW.EXE The executable program for VendView.
VENDVIEW.HLP Help file used by VendView.
CATEGORY.INF Product category data file used by VendView.
VENDINFO.DIZ The VENDINFO.DIZ file that describes the VendView
package itself. It's worth viewing both with a text
viewer and with the assistance of the VendView
program itself.
VendView Viewer v1.30 -8- Jun 1995
VendView User's Guide Installation
ORDER.FRM Order form for other tools and services associated
with the VENDINFO system. No registration is re-
quired to use VendView itself.
FILE_ID.DIZ A small file containing a description of this
package, currently used by many BBS and BBS-utility
programs to automatically load such descriptions
into their files databases. VENDINFO will even-
tually render this convention obsolete, but
FILE_ID.DIZ files should continue to be used, for
now.
VENDOR.DOC A small "stub" pointing the distributor to
VENDINFO.DIZ for information.
READ_ME.1ST A small "stub" pointing the user to VENDINFO.DIZ
for information.
Warranty and License
--------------------
VendView is a "freeware" product. You are free to use it without
registration or payment. Individuals may also give copies of it to
others, provided no fee is charged and the the copy distributed is
complete and unaltered. For policies regarding other distribution and
package modification, see the Distribution License in the
VENDINFO.DIZ file.
The Warranty and License governing your use of this product will be
found in the VENDINFO.DIZ file that accompanies this package. You can
view it using VendView itself, or view or print it with the tools you
use for ordinary text files.
Technical Support for VendView
------------------------------
If you have a problem with installation or use of this product, and
the documentation and help system don't provide the information you
need, we'll try to help. Please keep in mind, however, that this is a
free product, and there's a limit to the level of support we can
afford to provide for it. If possible, we would prefer to provide
help with this product via one of our public support forums (see
below), our product support BBS, or via some other electronic means.
If the need is great, however, or you just don't have access to the
other methods, you may use any of the contact methods indicated
below.
VendView Viewer v1.30 -9- Jun 1995
VendView User's Guide Installation
RAMS' ISLAND BBS
The Rams' Island BBS is a bulletin board system, accessible to you if
if you have a modem and communication software. On our BBS, you will
always find the latest version of the program, and you will be able
to ask technical questions of us and of our other users. We also
offer additional utilities, class definitions, application notes, and
other assistance to registered users via the BBS. The BBS phone
number is 303-841-6269.
COMPUSERVE INFORMATION SYSTEM
We also support this product on the CompuServe information system.
The latest version of the program is always available there in the
SHAREWARE and UKSHARE forums, and technical questions and support
requests may be sent to us via electronic mail there or on the
CompuServe SHAREWARE and UKSHARE forums. Our CompuServe user ID is
76244,324.
BBS NETWORK FORUMS
We have established VENDINFO support forums on both the FidoNet and
RIME networks. We are investigating a VENDINFO forum on GlobalNet.
OTHER ELECTRONIC ADDRESSES
You can reach us through three other computer networks (you can
usually find a local BBS that's also on these networks).
Our FidoNet address is 1:104/333.
Our RIME address is 1235 or RAMSISLE.
Our Internet address is ramsisle@abwam.com
FAX
You may reach us by FAX at 303-841-6269.
VOICE TELEPHONE
You may reach us by voice telephone at 303-841-2848.
MAIL
You may contact us by mail at
Rams' Island Software
7644 E. Lakecliff Way
Parker, Colorado 80134-5904
USA
VendView Viewer v1.30 -10- Jun 1995
VendView User's Guide VendView
+----------------------------------------------+
| VendView: A User's Viewer for VENDINFO Files |
+----------------------------------------------+
VendView is a simple menu-driven viewer allowing the end-user to see
relevant portions of the information in a VENDINFO.DIZ file. Its
operation is straightforward, but it can be used in two different
ways, and you need to understand the difference.
o It can be invoked simply to view VENDINFO files.
o It can be used to test package integrity, as well as to
view the VENDINFO file contained in a package.
Use of VendView Simply to View VENDINFO Files
---------------------------------------------
If you're not interested in testing the package contents for in-
tegrity, or you have only the VENDINFO file rather than the complete
package, then you can simply invoke VendView on the VENDINFO.DIZ
file. You can specify the desired file on the command line, so that:
vendview VENDINFO.DIZ
would load the VENDINFO.DIZ file. Alternatively, the simple command
vendview
will start the viewer and will automatically load VENDINFO.DIZ if it
is the only VENDINFO file in the directory.
If you have not placed VENDVIEW.EXE in a directory that's on your DOS
path, you'll need to use the full pathname of that file, such as:
c:\vendview\vendview.exe VENDINFO.DIZ
If you're executing VendView from a read-only medium, such as a CD-
ROM drive, you'll have to use the -d (directory) command-line flag,
to assign a writeable directory in which VendView can create its
VENDVIEW.CFG configuration file. You might also need to do this if
you're using a version of MS-DOS earlier than 3.0. An example might
be:
d:\files\vendview\vendview.exe -dc:\myconfig
If you maintain a collection of VENDINFO files, you will need to
rename them to match their corresponding package names, in which case
VendView Viewer v1.30 -11- Jun 1995
VendView User's Guide VendView
the directory may contain multiple VENDINFO files with names like
INCXT11.DIZ. To pre-load such a file, use the command
vendview INCXT11.DIZ
or you can simply load it manually after VendView is running, using
the File Load command.
Once you've invoked VendView, it should be pretty clear what to do.
Every menu item includes help text, as does every field of informa-
tion when you're viewing VENDINFO.DIZ content. To see the help infor-
mation, just press function key F1. Pressing F1 twice will always
cause VendView to display the index of the help system, from which
you can select topics for review. Just place the cursor on the
desired item, and press ENTER.
Use of VendView to Test Package Integrity
-----------------------------------------
To use VendView for this purpose, it is necessary to perform three
steps:
o Unpack the distribution package of the product you're evaluating
into an empty directory.
o Make sure that directory is the current working directory.
o Invoke VENDVIEW.EXE.
Let's consider each of these steps in turn.
To unpack the distribution package appropriately, you should either
create a new directory or use an existing, empty directory. It is
important that the directory contain no files other than those from
the package, since the files in the directory will be compared with
those released by the author. If you've received the package in the
form of a compressed file (e.g., PACKAGE.ZIP), then a sequence like
this might be appropriate:
c:
cd \
mkdir tempdir
cd tempdir
copy <place full path of source directory here>\PACKAGE.ZIP
pkunzip PACKAGE.ZIP
del PACKAGE.ZIP
If you've received the package on a diskette that's in drive A, then
VendView Viewer v1.30 -12- Jun 1995
VendView User's Guide VendView
the sequence might be:
c:
cd \
mkdir tempdir
cd tempdir
copy A:\*.*/v
Obviously, the exact procedure used here will depend on how you have
your system configured and what tools you have available. The above
examples are provided mainly to help you understand the intended
effect.
The examples above have the side effect that the relevant directory
is the current working directory after the commands have been ex-
ecuted. If you use some other sequence or tool to unpack the package,
you may then need to do something like this:
c:
cd \tempdir
Finally, you need to invoke VENDVIEW.EXE, using the command:
vendview
if you have placed VENDVIEW.EXE in a directory that's on your DOS
PATH, or
c:\tools\vendview
if (as an example) it is located in C:\TOOLS, which is not on your
DOS PATH.
This will start VendView, which will automatically load the
VENDINFO.DIZ file from the package, assuming it is a normal package
containing only VENDINFO.DIZ, perhaps FILE_ID.DIZ, and no other files
with filename extension "DIZ".
You can now view the contents of the VENDINFO.DIZ file itself, and
the Test Package command will allow you to test package integrity, by
comparing the package's Packing List with the actual file contents of
the package. ated in C:\TOOLS, which is not on your
VendView Viewer v1.30 -13- Jun 1995
